<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN"
  "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
<html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en" lang="en">
  <head>
    <meta http-equiv="Content-Type" content="text/html; charset=UTF-8" />
<title>
  File: README.md
  
    &mdash; Documentation by YARD 0.7.2
  
</title>

  <link rel="stylesheet" href="css/style.css" type="text/css" media="screen" charset="utf-8" />

  <link rel="stylesheet" href="css/common.css" type="text/css" media="screen" charset="utf-8" />

<script type="text/javascript" charset="utf-8">
  relpath = '';
  if (relpath != '') relpath += '/';
</script>

  <script type="text/javascript" charset="utf-8" src="js/jquery.js"></script>

  <script type="text/javascript" charset="utf-8" src="js/app.js"></script>


  </head>
  <body>
    <script type="text/javascript" charset="utf-8">
      if (window.top.frames.main) document.body.className = 'frames';
    </script>
    
    <div id="header">
      <div id="menu">
  
    <a href="_index.html" title="Index">Index</a> &raquo; 
    <span class="title">File: README.md</span>
  
  
  <div class="noframes"><span class="title">(</span><a href="." target="_top">no frames</a><span class="title">)</span></div>
</div>

      <div id="search">
  
    <a id="class_list_link" href="#">Class List</a>
  
    <a id="method_list_link" href="#">Method List</a>
  
    <a id="file_list_link" href="#">File List</a>
  
</div>
      <div class="clear"></div>
    </div>
    
    <iframe id="search_frame"></iframe>
    
    <div id="content"><div id='filecontents'><p>
## Description
</p>
<p>
This is a template repository for Ruby and RSpec along with Autotest and
RCov.
</p>
<p>
## Bootstrapping
</p>
<pre class="code">
    $ git init
    $ echo &quot;*~&quot; &gt;&gt; .git/info/exclude              # Ignores temporary editor files from git ~ without polluting .gitignore

  Edit README:
    $ cp README.md.sample README.md

  Create code directories:
    $ mkdir spec  # tests
    $ mkdir lib # classes or modules
    $ mkdir bin # executables

  Install rvm with Ruby-1.9.2.
    $ rvm install 1.9.2
  
  Install bundler for managing your applications dependencies:
    
    $ gem install bundler
    $ bundle install --path vendor
    $ bundle package
</pre>
<p>
## Platform-specific Gems
</p>
<pre class="code">
  If you're on a mac, you don't want linux gems:
    $ bundle install --path vendor --without linux
    
  And if you're on linux:
    $ bundle install --path vendor --without osx
  
</pre>
<p>
## Testing
</p>
<pre class="code">
    $ bundle exec autotest
</pre>
<p>
## Test Code Coverage
</p>
<pre class="code">
  Test coverage is generated in spec/coverage when you run this:
  
    $ COVERAGE=true bundle exec rake spec
    
  There's also flog that identifies badly written methods and gives them a high flog score:
  
    $ bundle exec rake flog
    
</pre>
<p>
## Gem building and push to gems.mobme.in
</p>
<pre class="code">
  To build a gem and push to gems.mobme.in, create a .gemspec and then do:
  
    $ bundle exec rake gem:push</pre>
</div></div>
    
    <div id="footer">
  Generated on Sun Mar  4 10:17:36 2012 by 
  <a href="http://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
  0.7.2 (ruby-1.9.2).
</div>

  </body>
</html>